home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload Trio 2 / Shareware Overload Trio Volume 2 (Chestnut CD-ROM).ISO / dir39 / envform.zip / README.TXT < prev    next >
Text File  |  1994-10-17  |  8KB  |  244 lines
  1.                                  Contents
  2.                                  --------
  3.  
  4.  
  5.  
  6.  
  7.  
  8. Section 1       Program Description
  9.  
  10. Section 2       Screen File
  11.  
  12. Section 3       INI File Parameters
  13.  
  14. Section 4       Errors / Return Codes
  15.  
  16. Section 5       Special Notes / Considerations
  17.  
  18. Section 6       Examples
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26. ENVFORM is a C program I wrote to accomplish a specific need.  Upon
  27. completion, I decided to distribute it under the shareware concept.  You may
  28. use the software to determine if it meets your needs.  If you then decide to
  29. continue using the software you pay a license fee to the author.  The license
  30. fee for this package is $10.00.  This fee entitles you to use the software
  31. royalty free.
  32.  
  33. If you choose to license ENVFORM, please send the $10.00 license fee to:
  34.  
  35.  
  36.         Steve Lundeen
  37.         Software Integration Group, Inc.
  38.         P.O. Box 723847
  39.         Atlanta, GA  31139
  40.  
  41.  
  42. Whatever you decide to do, please distribute this software to any bulletin
  43. boards you wish. I may be contacted at CIS[71051,1243].
  44.  
  45.  
  46. ENVFORM uses The Window Boss screen I/O routines provided by Philip A.
  47. Mongelluzzo, Star Guidance Consulting, Inc.
  48.  
  49.  
  50.  
  51. DISCLAIMER
  52. ----------
  53.  
  54. THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  55. EXPRESSED OR IMPLIED. We cannot be held liable for any loss of profit or any
  56. other commercial damage, including but not limited to, special; incidental;
  57. consequential; or other damages.
  58.  
  59. Section 1 - Program Description
  60. -------------------------------
  61.  
  62. ENVFORM is a parameter driven program which allows you to perform full screen
  63. input of DOS enviroment variables.  The fields can be set to the values of DOS
  64. environment variables pior to the calling of the program, allowing you to
  65. establish desired defaults.  ENVFORM is also capable of displaying error
  66. messages to instruct the user to re-enter invalid information.
  67.  
  68. ENVFORM requires the use of two files, an .INI file which contains control
  69. information and a text file which is displayed on the screen upon program
  70. entry.
  71.  
  72. When invoked, ENVFORM parses the passed INI file for required information.  If
  73. any required parameters are not specified, the program will set the
  74. appropriate return code and terminate.  After successfully interrogating the
  75. INI file, the program will then display the screen contained in the text file
  76. specified.  Next, the program will solicite input from the user to fill the
  77. defined fields.  If the user presses escape to exit the screen, a return code
  78. will be set to denote this action.  Once the user accepts the entries, the DOS
  79. environment variables are set and, if specified, a batch file is created in
  80. the designated directory.  Optionally, ENVFORM can invoke another program upon
  81. entry of all the fields.
  82.  
  83.  
  84. Section 2 - Screen File
  85. -----------------------
  86.  
  87. The screen file is typically a 24 row by 80 column text file.  This file is
  88. written to the screen, starting at the top left corner.  Row 25 is reserved
  89. for program use.  Included with this download are four sample screen form
  90. files, FORM1.TXT through FORM4.TXT.  These are just text files which can be
  91. used for initial form design or as copy and paste objects.
  92.  
  93.  
  94. Section 3 - INI File Parameters
  95. -------------------------------
  96.  
  97. The INI file consists of the following sections and keys:
  98.  
  99.         [ENVFORM]
  100.         SCREEN=text file name
  101.         RUN=program file to invoke
  102.         BATCH=batch file name for SET statements
  103.         ERRORLOCATION=row,column
  104.         PUTFORECOLOR=color
  105.         PUTBACKCOLOR=color
  106.         GETFORECOLOR=color
  107.         GETBACKCOLOR=color
  108.  
  109.         [ENVVARS]
  110.         var1=row,column,length
  111.         var2= row,column,length
  112.         varn= row,column,length
  113.  
  114.         [ENVTEXT]
  115.         var1=row,column,foreground color,background color
  116.         var2=row,column,foreground color,background color
  117.         .
  118.         .
  119.         varn=row,column,foreground color,background color
  120.  
  121. [ENVFORM] section
  122.  
  123. SCREEN=text file name
  124.  
  125.         Specify the name of the text file to be displayed upon program entry.
  126.         This file can contain any displayable ASCII characters.  This file
  127.         should not be more than 24 rows by 80 columns.
  128.  
  129.  
  130.  
  131. RUN=program file to invoke
  132.  
  133.         Specify the name of the program to run after the user accepts the input.
  134.         This can be a .BAT, .COM, or .EXE file.  This program will receive a
  135.         copy of the environment which contains the specified DOS environment
  136.         variables.
  137.  
  138. BATCH=batch file name for SET statements
  139.  
  140.         If specified, this batch file will be created and contain DOS SET
  141.         statements which can be execute to set the environment variables
  142.         specified.  This is useful for integrating ENVFORM with batch files.
  143.  
  144. ENVLOCATION=row,column
  145.  
  146.         Specify the row and column to display a blinking error message to the
  147.         user.  Error messages can be passed to ENVFORM in the DOS ENVERROR
  148.         environment variable.  If upon program entry the variable ENVERROR
  149.         exists, its contents will be displayed at the row and column specified
  150.         by ENVLOCATION.  If the column is set to zero, the text will be
  151.         centered.
  152.  
  153. PUTFORECOLOR=color
  154. PUTBACKCOLOR=color
  155. GETFORECOLOR=color
  156. GETBACKCOLOR=color
  157.  
  158.         Specify the color values for the foreground and background colors for
  159.         the text display (PUT) and field variables (GET).  The color values are
  160.         as follows:
  161.  
  162.                 0 = Black       4 = Red
  163.                 1 = Blue        5 = Magenta
  164.                 2 = Green       6 = Yellow
  165.                 3 = Cyan        7 = White
  166.  
  167.  
  168. [ENVVARS] section
  169.  
  170. varx=row,column,length
  171.  
  172.         These values specify the variables to be accepted during data entry.
  173.         Each variable entered here will correspond to a screen field as well as
  174.         a DOS environment variable.  The name preceding the equal sign will be
  175.         the name of the environment variable.  If the variable exists in the
  176.         current environment, its contents will be used as a default during data
  177.         entry.  The screen position for this field is specified by the row and
  178.         colmun values.  The of the field length used during data entry is
  179.         specified by the length value.
  180.  
  181.         The top left corner of the screen is row one, column one.  This method
  182.         was chosen due to the fact that most text editors display the row and
  183.         column when editing files.
  184.  
  185. [ENVTEXT] section
  186.  
  187. varx=row,column,color
  188.  
  189.         These values specify DOS environment variables to be displayed within
  190.         the data entry form. The top left corner of the screen is row one,
  191.         column one.  If column is set to zero, the text is centered.  The color
  192.         values are the same as in the [ENVFORM] section.
  193.  
  194.  
  195.  
  196.  
  197. Section 4 - Errors / Return Codes
  198. ---------------------------------
  199.  
  200. When ENVFORM terminates, the following return codes (ERRORLEVEL) are set:
  201.  
  202.         0 = Normal completion
  203.         1 = Screen error, possible row/column error
  204.         2 = INI file not found
  205.         3 = Screen file not found
  206.         4 = Run file not found
  207.         5 = Run file could not be invoked
  208.         6 = Batch file could not be created
  209.         7 = Reserved, not used
  210.         8 = User pressed ESCape
  211.  
  212.  
  213. Section 5 - Special Notes / Considerations
  214. ------------------------------------------
  215.  
  216. If you receive an 'Out of environment space' message, the amount of memory
  217. allocated for the DOS environment may need to be increased.  Adding the
  218. following line to your CONFIG.SYS file may correct the problem:
  219.  
  220.         SHELL=C:\COMMAND.COM /E:512 /P
  221.  
  222. Reference the 'COMMAND' command in your DOS manual for more information.
  223.  
  224.  
  225. Section 6 - Examples
  226. --------------------
  227.  
  228. Several examples should have been included in this download.  Remarks within
  229. each sample should provide you with ample information to design your own
  230. ENVFORM applications.
  231.  
  232. Example 1 
  233.  
  234.   EX1.BAT - Simple form to run DOS EDIT.
  235.  
  236. Example 2 
  237.   
  238.   EX2.BAT - Simple form to run DOS EDIT, with error checking.
  239.  
  240. Example 3 
  241.   
  242.   EX3.BAT - Form to accept and validate data.  Sample application.
  243.  
  244.